<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__ipc__bt__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__ipc.html">IPC          (Inter Process Communication)</a> &raquo; <a class="el" href="group__group__ipc__bt.html">IPC Bluetooth sub-system layer (IPC_BTSS)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>Functions are used in the driver. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad43df1ebf07766591ecec7ca2d8da891"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#gad43df1ebf07766591ecec7ca2d8da891">Cy_BTIPC_Init</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, <a class="el" href="structcy__stc__ipc__bt__config__t.html">cy_stc_ipc_bt_config_t</a> *btIpcConfig)</td></tr>
<tr class="memdesc:gad43df1ebf07766591ecec7ca2d8da891"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the Bluetooth IPC.  <a href="#gad43df1ebf07766591ecec7ca2d8da891">More...</a><br /></td></tr>
<tr class="separator:gad43df1ebf07766591ecec7ca2d8da891"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6806dd52ab848f79430cd1e5ae4f4970"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga6806dd52ab848f79430cd1e5ae4f4970">Cy_BTIPC_WarmInit</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, <a class="el" href="structcy__stc__ipc__bt__config__t.html">cy_stc_ipc_bt_config_t</a> *btIpcConfig)</td></tr>
<tr class="memdesc:ga6806dd52ab848f79430cd1e5ae4f4970"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs the warm initialization of the Bluetooth IPC.  <a href="#ga6806dd52ab848f79430cd1e5ae4f4970">More...</a><br /></td></tr>
<tr class="separator:ga6806dd52ab848f79430cd1e5ae4f4970"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7fd5e6171ad7c016fed7973732af742e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga7fd5e6171ad7c016fed7973732af742e">Cy_BTIPC_Deinit</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext)</td></tr>
<tr class="memdesc:ga7fd5e6171ad7c016fed7973732af742e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function de-initializes the Bluetooth IPC.  <a href="#ga7fd5e6171ad7c016fed7973732af742e">More...</a><br /></td></tr>
<tr class="separator:ga7fd5e6171ad7c016fed7973732af742e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga01c1a4a339ce87f156fc2c987c83f145"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga01c1a4a339ce87f156fc2c987c83f145">Cy_BTIPC_HCI_getPTI</a> (<a class="el" href="group__group__ipc__bt__enums.html#gabba22d4c874c46f722296fa64864abe7">cy_en_btipc_hcipti_t</a> *pti, uint32_t *p_length, uint32_t *msgPtr)</td></tr>
<tr class="memdesc:ga01c1a4a339ce87f156fc2c987c83f145"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the payload type indicator and the length of the HCI packet received from BTSS.  <a href="#ga01c1a4a339ce87f156fc2c987c83f145">More...</a><br /></td></tr>
<tr class="separator:ga01c1a4a339ce87f156fc2c987c83f145"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ed852315887584fde1a533f0a51fa67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga4ed852315887584fde1a533f0a51fa67">Cy_BTIPC_HCI_Write</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, <a class="el" href="group__group__ipc__bt__enums.html#gabba22d4c874c46f722296fa64864abe7">cy_en_btipc_hcipti_t</a> pti, void *data, size_t length)</td></tr>
<tr class="memdesc:ga4ed852315887584fde1a533f0a51fa67"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends the HCI packet form the BT stack to the BTSS.  <a href="#ga4ed852315887584fde1a533f0a51fa67">More...</a><br /></td></tr>
<tr class="separator:ga4ed852315887584fde1a533f0a51fa67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga815dbbfee3eddc1f6a56d1297bd19b87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga815dbbfee3eddc1f6a56d1297bd19b87">Cy_BTIPC_HPC_Write</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, void *data, size_t length)</td></tr>
<tr class="memdesc:ga815dbbfee3eddc1f6a56d1297bd19b87"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends the HPC packet form the MCU to the BTSS.  <a href="#ga815dbbfee3eddc1f6a56d1297bd19b87">More...</a><br /></td></tr>
<tr class="separator:ga815dbbfee3eddc1f6a56d1297bd19b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga60c4054b61b0035c00ebb450c7c2adfb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga60c4054b61b0035c00ebb450c7c2adfb">Cy_BTIPC_HCI_GetReadBufPtr</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, void **ppData, size_t *pLength)</td></tr>
<tr class="memdesc:ga60c4054b61b0035c00ebb450c7c2adfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the pointer to the received HCI packet by MCU from BTSS.  <a href="#ga60c4054b61b0035c00ebb450c7c2adfb">More...</a><br /></td></tr>
<tr class="separator:ga60c4054b61b0035c00ebb450c7c2adfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31ed9c241bf8852c16ca89eed58bf0db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga31ed9c241bf8852c16ca89eed58bf0db">Cy_BTIPC_HCI_GetWriteBufPtr</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, <a class="el" href="group__group__ipc__bt__enums.html#gabba22d4c874c46f722296fa64864abe7">cy_en_btipc_hcipti_t</a> pti, void **ppData, size_t length)</td></tr>
<tr class="memdesc:ga31ed9c241bf8852c16ca89eed58bf0db"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the pointer to the buffer to write HCI packet to send to BTSS.  <a href="#ga31ed9c241bf8852c16ca89eed58bf0db">More...</a><br /></td></tr>
<tr class="separator:ga31ed9c241bf8852c16ca89eed58bf0db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa77318a8bfc8d340ae0a43e5fe654e41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#gaa77318a8bfc8d340ae0a43e5fe654e41">Cy_BTIPC_HPC_GetWriteBufPtr</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, void **ppData, size_t length)</td></tr>
<tr class="memdesc:gaa77318a8bfc8d340ae0a43e5fe654e41"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the pointer to the buffer to write HPC long message packet to send to BTSS.  <a href="#gaa77318a8bfc8d340ae0a43e5fe654e41">More...</a><br /></td></tr>
<tr class="separator:gaa77318a8bfc8d340ae0a43e5fe654e41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga675493b798f9525c10c1cf97a6538534"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga675493b798f9525c10c1cf97a6538534">Cy_BTIPC_HCI_RelChannel</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext)</td></tr>
<tr class="memdesc:ga675493b798f9525c10c1cf97a6538534"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function releases the HCI channel after handling the notification from the BT SS.  <a href="#ga675493b798f9525c10c1cf97a6538534">More...</a><br /></td></tr>
<tr class="separator:ga675493b798f9525c10c1cf97a6538534"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6ab99220260ce6cb77a7527616bf183"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#gae6ab99220260ce6cb77a7527616bf183">Cy_BTIPC_HCI_RelBuffer</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, uint32_t *msgPtr)</td></tr>
<tr class="memdesc:gae6ab99220260ce6cb77a7527616bf183"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function releases the HCI buffer after copying the data received from BTSS.  <a href="#gae6ab99220260ce6cb77a7527616bf183">More...</a><br /></td></tr>
<tr class="separator:gae6ab99220260ce6cb77a7527616bf183"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga222578ff38f3b9bbdede0b6ec3cd6fa3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga222578ff38f3b9bbdede0b6ec3cd6fa3">Cy_BTIPC_HPC_RelChannel</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, void *buf)</td></tr>
<tr class="memdesc:ga222578ff38f3b9bbdede0b6ec3cd6fa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function releases the HPC channel after handling the notification from the BT SS.  <a href="#ga222578ff38f3b9bbdede0b6ec3cd6fa3">More...</a><br /></td></tr>
<tr class="separator:ga222578ff38f3b9bbdede0b6ec3cd6fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga667e71029ca91c810c5d9ee0ee3d8d8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga667e71029ca91c810c5d9ee0ee3d8d8a">Cy_BTIPC_HCI_RegisterCb</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, cy_ipc_bt_callback_ptr_t hciNotifyCallbackPtr)</td></tr>
<tr class="memdesc:ga667e71029ca91c810c5d9ee0ee3d8d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function registers the callback for HCI message notifications from BT SS.  <a href="#ga667e71029ca91c810c5d9ee0ee3d8d8a">More...</a><br /></td></tr>
<tr class="separator:ga667e71029ca91c810c5d9ee0ee3d8d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2cfef0a754419d0e689da171b7174aa1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga2cfef0a754419d0e689da171b7174aa1">Cy_BTIPC_HCI_UnregisterCb</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext)</td></tr>
<tr class="memdesc:ga2cfef0a754419d0e689da171b7174aa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function un-registers the callback function registered for HCI message notifications from BT SS.  <a href="#ga2cfef0a754419d0e689da171b7174aa1">More...</a><br /></td></tr>
<tr class="separator:ga2cfef0a754419d0e689da171b7174aa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6522e438e7f526be1af60ab96d80d910"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga6522e438e7f526be1af60ab96d80d910">Cy_BTIPC_HPC_RegisterCb</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, <a class="el" href="structcy__stc__ipc__hcp__cb__t.html">cy_stc_ipc_hcp_cb_t</a> *pHpcNotifyCallbackParam)</td></tr>
<tr class="memdesc:ga6522e438e7f526be1af60ab96d80d910"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function registers the callback for HPC message notifications from BT SS.  <a href="#ga6522e438e7f526be1af60ab96d80d910">More...</a><br /></td></tr>
<tr class="separator:ga6522e438e7f526be1af60ab96d80d910"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga75e394aa74ca5218b77282a8cc48f330"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga75e394aa74ca5218b77282a8cc48f330">Cy_BTIPC_HPC_UnregisterCb</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, <a class="el" href="structcy__stc__ipc__hcp__cb__t.html">cy_stc_ipc_hcp_cb_t</a> *pHpcNotifyCallbackParam)</td></tr>
<tr class="memdesc:ga75e394aa74ca5218b77282a8cc48f330"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function un-registers the callback function registered for HPC message notifications from BT SS.  <a href="#ga75e394aa74ca5218b77282a8cc48f330">More...</a><br /></td></tr>
<tr class="separator:ga75e394aa74ca5218b77282a8cc48f330"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga04bc70532711939c7f13d232b31703c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga04bc70532711939c7f13d232b31703c7">Cy_BTIPC_Buffer_RegisterCb</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, cy_ipc_bt_bufcallback_ptr_t bufCallbackPtr)</td></tr>
<tr class="memdesc:ga04bc70532711939c7f13d232b31703c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function registers the callback for buffer available notification.  <a href="#ga04bc70532711939c7f13d232b31703c7">More...</a><br /></td></tr>
<tr class="separator:ga04bc70532711939c7f13d232b31703c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e0f27799004ccf2fba8cac1b94a1ada"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga4e0f27799004ccf2fba8cac1b94a1ada">Cy_BTIPC_HCI_FIFOGet</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, uint32_t **ppMsg, uint8_t delete)</td></tr>
<tr class="memdesc:ga4e0f27799004ccf2fba8cac1b94a1ada"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to pull the IPC message from FIFO.  <a href="#ga4e0f27799004ccf2fba8cac1b94a1ada">More...</a><br /></td></tr>
<tr class="separator:ga4e0f27799004ccf2fba8cac1b94a1ada"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga82dd3a8bafc6c144dd7b6886513276ae"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga82dd3a8bafc6c144dd7b6886513276ae">Cy_BTIPC_HCI_FIFOCount</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext)</td></tr>
<tr class="memdesc:ga82dd3a8bafc6c144dd7b6886513276ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to get the number of messages in the IPC FIFO.  <a href="#ga82dd3a8bafc6c144dd7b6886513276ae">More...</a><br /></td></tr>
<tr class="separator:ga82dd3a8bafc6c144dd7b6886513276ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5bc491552eb2d1f39770826623a07230"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga5bc491552eb2d1f39770826623a07230">Cy_BTIPC_RetrieveContext</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, <a class="el" href="structcy__stc__ipc__bt__save__ctxt__t.html">cy_stc_ipc_bt_save_ctxt_t</a> *pContextRet)</td></tr>
<tr class="memdesc:ga5bc491552eb2d1f39770826623a07230"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to retrieve the context to be saved during RAM off state.  <a href="#ga5bc491552eb2d1f39770826623a07230">More...</a><br /></td></tr>
<tr class="separator:ga5bc491552eb2d1f39770826623a07230"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51fd7f73cee8856a78c5bdcea1f132be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__bt__functions.html#ga51fd7f73cee8856a78c5bdcea1f132be">Cy_BTIPC_RestoreContext</a> (<a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *btIpcContext, <a class="el" href="structcy__stc__ipc__bt__save__ctxt__t.html">cy_stc_ipc_bt_save_ctxt_t</a> *pContextRet)</td></tr>
<tr class="memdesc:ga51fd7f73cee8856a78c5bdcea1f132be"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to restore the saved context during RAM off state.  <a href="#ga51fd7f73cee8856a78c5bdcea1f132be">More...</a><br /></td></tr>
<tr class="separator:ga51fd7f73cee8856a78c5bdcea1f132be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad43df1ebf07766591ecec7ca2d8da891"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad43df1ebf07766591ecec7ca2d8da891">&#9670;&nbsp;</a></span>Cy_BTIPC_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__config__t.html">cy_stc_ipc_bt_config_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcConfig</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the Bluetooth IPC. </p>
<p>The IPC channels used for HCI and HPC packet exchange between MCU and BT SS are initialized.</p>
<dl class="section note"><dt>Note</dt><dd>In general, this function is called during application initialization.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">btIpcConfig</td><td>This is the pointer to the bt ipc configuration structure.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR: BT IPC API return for general error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle </dd></dl>

</div>
</div>
<a id="ga6806dd52ab848f79430cd1e5ae4f4970"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6806dd52ab848f79430cd1e5ae4f4970">&#9670;&nbsp;</a></span>Cy_BTIPC_WarmInit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_WarmInit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__config__t.html">cy_stc_ipc_bt_config_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcConfig</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function performs the warm initialization of the Bluetooth IPC. </p>
<dl class="section note"><dt>Note</dt><dd>In general, this function is called during application warm boot initialization.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">btIpcConfig</td><td>This is the pointer to the bt ipc configuration structure.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR: BT IPC API return for general error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle </dd></dl>

</div>
</div>
<a id="ga7fd5e6171ad7c016fed7973732af742e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7fd5e6171ad7c016fed7973732af742e">&#9670;&nbsp;</a></span>Cy_BTIPC_Deinit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_Deinit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function de-initializes the Bluetooth IPC. </p>
<p>All the registered callbacks are deleted.</p>
<dl class="section note"><dt>Note</dt><dd>In general, this function is called when the application does not need BT IPC service anymore.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle </dd></dl>

</div>
</div>
<a id="ga01c1a4a339ce87f156fc2c987c83f145"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga01c1a4a339ce87f156fc2c987c83f145">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_getPTI()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_getPTI </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__ipc__bt__enums.html#gabba22d4c874c46f722296fa64864abe7">cy_en_btipc_hcipti_t</a> *&#160;</td>
          <td class="paramname"><em>pti</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>p_length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>msgPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function gets the payload type indicator and the length of the HCI packet received from BTSS. </p>
<p>This function can be called to find out the type of HCI packet and allocate buffer of appropriate size to copy the packet data.</p>
<dl class="section note"><dt>Note</dt><dd>In general, this function is called before reading the packet to allocate memory of required size.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pti</td><td>This is the pointer to payload type indicator which is returned by the function.</td></tr>
    <tr><td class="paramname">p_length</td><td>This is the pointer to the length of the payload filled by the function.</td></tr>
    <tr><td class="paramname">msgPtr</td><td>This is the pointer to buffer which contains the IPC data received in DATA0 and DATA1 registers.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle </dd></dl>

</div>
</div>
<a id="ga4ed852315887584fde1a533f0a51fa67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ed852315887584fde1a533f0a51fa67">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_Write()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_Write </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__ipc__bt__enums.html#gabba22d4c874c46f722296fa64864abe7">cy_en_btipc_hcipti_t</a>&#160;</td>
          <td class="paramname"><em>pti</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends the HCI packet form the BT stack to the BTSS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pti</td><td>This is the HCI payload type indicator.</td></tr>
    <tr><td class="paramname">data</td><td>This is the pointer to the buffer holding the HCI payload.</td></tr>
    <tr><td class="paramname">length</td><td>This is the length of the HCI payload in number of bytes.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR_LOCK_ACQUIRE: BT IPC API return for buffer pool full error </dd></dl>

</div>
</div>
<a id="ga815dbbfee3eddc1f6a56d1297bd19b87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga815dbbfee3eddc1f6a56d1297bd19b87">&#9670;&nbsp;</a></span>Cy_BTIPC_HPC_Write()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HPC_Write </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends the HPC packet form the MCU to the BTSS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>This is the pointer to the buffer holding the HPC payload.</td></tr>
    <tr><td class="paramname">length</td><td>This is the length of the HPC payload in number of bytes.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR_LOCK_ACQUIRE: BT IPC API return for buffer pool full error </dd></dl>

</div>
</div>
<a id="ga60c4054b61b0035c00ebb450c7c2adfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga60c4054b61b0035c00ebb450c7c2adfb">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_GetReadBufPtr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_GetReadBufPtr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void **&#160;</td>
          <td class="paramname"><em>ppData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>pLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function gets the pointer to the received HCI packet by MCU from BTSS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppData</td><td>This is the pointer to the pointer of received HCI payload buffer</td></tr>
    <tr><td class="paramname">pLength</td><td>This is the pointer to the size of the payload received in number of bytes</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR_LOCK_ACQUIRE: BT IPC API return for buffer pool full error CY_BT_IPC_DRV_ERROR_LOCK_REL: BT IPCAPI return for channel release error </dd></dl>

</div>
</div>
<a id="ga31ed9c241bf8852c16ca89eed58bf0db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga31ed9c241bf8852c16ca89eed58bf0db">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_GetWriteBufPtr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_GetWriteBufPtr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__ipc__bt__enums.html#gabba22d4c874c46f722296fa64864abe7">cy_en_btipc_hcipti_t</a>&#160;</td>
          <td class="paramname"><em>pti</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void **&#160;</td>
          <td class="paramname"><em>ppData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function gets the pointer to the buffer to write HCI packet to send to BTSS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pti</td><td>This is the HCI payload type indicator.</td></tr>
    <tr><td class="paramname">ppData</td><td>This is the pointer to the pointer of buffer to write HCI payload buffer</td></tr>
    <tr><td class="paramname">length</td><td>This is the length of the HCI payload in number of bytes.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR_LOCK_ACQUIRE: BT IPC API return for buffer pool full error CY_BT_IPC_DRV_ERROR_LOCK_REL: BT IPCAPI return for channel release error </dd></dl>

</div>
</div>
<a id="gaa77318a8bfc8d340ae0a43e5fe654e41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa77318a8bfc8d340ae0a43e5fe654e41">&#9670;&nbsp;</a></span>Cy_BTIPC_HPC_GetWriteBufPtr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HPC_GetWriteBufPtr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void **&#160;</td>
          <td class="paramname"><em>ppData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function gets the pointer to the buffer to write HPC long message packet to send to BTSS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppData</td><td>This is the pointer to the pointer of buffer to write HPC long message payload buffer</td></tr>
    <tr><td class="paramname">length</td><td>This is the length of the HPC payload in number of bytes.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR_LOCK_ACQUIRE: BT IPC API return for buffer pool full error CY_BT_IPC_DRV_ERROR_LOCK_REL: BT IPCAPI return for channel release error </dd></dl>

</div>
</div>
<a id="ga675493b798f9525c10c1cf97a6538534"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga675493b798f9525c10c1cf97a6538534">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_RelChannel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_RelChannel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function releases the HCI channel after handling the notification from the BT SS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR_LOCK_REL: BT IPCAPI return for channel release error </dd></dl>

</div>
</div>
<a id="gae6ab99220260ce6cb77a7527616bf183"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae6ab99220260ce6cb77a7527616bf183">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_RelBuffer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_RelBuffer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>msgPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function releases the HCI buffer after copying the data received from BTSS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
    <tr><td class="paramname">msgPtr</td><td>This is the pointer to the IPC message received form BTSS</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR_LOCK_REL: BT IPCAPI return for channel release error </dd></dl>

</div>
</div>
<a id="ga222578ff38f3b9bbdede0b6ec3cd6fa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga222578ff38f3b9bbdede0b6ec3cd6fa3">&#9670;&nbsp;</a></span>Cy_BTIPC_HPC_RelChannel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HPC_RelChannel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>buf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function releases the HPC channel after handling the notification from the BT SS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buf</td><td>This is the pointer to the buffer received from BT SS in DATA0 and DATA1 channel registers.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR_LOCK_REL: BT IPCAPI return for channel release error </dd></dl>

</div>
</div>
<a id="ga667e71029ca91c810c5d9ee0ee3d8d8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga667e71029ca91c810c5d9ee0ee3d8d8a">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_RegisterCb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_RegisterCb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">cy_ipc_bt_callback_ptr_t&#160;</td>
          <td class="paramname"><em>hciNotifyCallbackPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function registers the callback for HCI message notifications from BT SS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">hciNotifyCallbackPtr</td><td>This is the pointer to the function to be called for HCI notifications.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle </dd></dl>

</div>
</div>
<a id="ga2cfef0a754419d0e689da171b7174aa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2cfef0a754419d0e689da171b7174aa1">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_UnregisterCb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_UnregisterCb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function un-registers the callback function registered for HCI message notifications from BT SS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle </dd></dl>

</div>
</div>
<a id="ga6522e438e7f526be1af60ab96d80d910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6522e438e7f526be1af60ab96d80d910">&#9670;&nbsp;</a></span>Cy_BTIPC_HPC_RegisterCb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HPC_RegisterCb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__hcp__cb__t.html">cy_stc_ipc_hcp_cb_t</a> *&#160;</td>
          <td class="paramname"><em>pHpcNotifyCallbackParam</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function registers the callback for HPC message notifications from BT SS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pHpcNotifyCallbackParam</td><td>This is the pointer to the function to be called for HPC notifications.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR: BT IPC API return for general error </dd></dl>

</div>
</div>
<a id="ga75e394aa74ca5218b77282a8cc48f330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga75e394aa74ca5218b77282a8cc48f330">&#9670;&nbsp;</a></span>Cy_BTIPC_HPC_UnregisterCb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HPC_UnregisterCb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__hcp__cb__t.html">cy_stc_ipc_hcp_cb_t</a> *&#160;</td>
          <td class="paramname"><em>pHpcNotifyCallbackParam</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function un-registers the callback function registered for HPC message notifications from BT SS. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pHpcNotifyCallbackParam</td><td>This is the pointer to the callback function to be un-registered.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR: BT IPC API return for general error </dd></dl>

</div>
</div>
<a id="ga04bc70532711939c7f13d232b31703c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04bc70532711939c7f13d232b31703c7">&#9670;&nbsp;</a></span>Cy_BTIPC_Buffer_RegisterCb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_Buffer_RegisterCb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">cy_ipc_bt_bufcallback_ptr_t&#160;</td>
          <td class="paramname"><em>bufCallbackPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function registers the callback for buffer available notification. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bufCallbackPtr</td><td>This is the pointer to the function to be called for buffer available notification.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle CY_BT_IPC_DRV_ERROR: BT IPC API return for general error </dd></dl>

</div>
</div>
<a id="ga4e0f27799004ccf2fba8cac1b94a1ada"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e0f27799004ccf2fba8cac1b94a1ada">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_FIFOGet()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_HCI_FIFOGet </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t **&#160;</td>
          <td class="paramname"><em>ppMsg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>delete</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to pull the IPC message from FIFO. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppMsg</td><td>This is the pointer to pointer the location in FIFO where the retrieved message is stored.</td></tr>
    <tr><td class="paramname">delete</td><td>When set to 1, the entry from the FIFO is deleted after pulling it.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BUF_FULL : BT IPC API return for FIFO full </dd></dl>

</div>
</div>
<a id="ga82dd3a8bafc6c144dd7b6886513276ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga82dd3a8bafc6c144dd7b6886513276ae">&#9670;&nbsp;</a></span>Cy_BTIPC_HCI_FIFOCount()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t Cy_BTIPC_HCI_FIFOCount </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to get the number of messages in the IPC FIFO. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of messages in the IPC FIFO </dd></dl>

</div>
</div>
<a id="ga5bc491552eb2d1f39770826623a07230"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5bc491552eb2d1f39770826623a07230">&#9670;&nbsp;</a></span>Cy_BTIPC_RetrieveContext()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_RetrieveContext </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__save__ctxt__t.html">cy_stc_ipc_bt_save_ctxt_t</a> *&#160;</td>
          <td class="paramname"><em>pContextRet</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to retrieve the context to be saved during RAM off state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pContextRet</td><td>Pointer to the context to be retrieved. This will be updated by this function.</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle </dd></dl>

</div>
</div>
<a id="ga51fd7f73cee8856a78c5bdcea1f132be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga51fd7f73cee8856a78c5bdcea1f132be">&#9670;&nbsp;</a></span>Cy_BTIPC_RestoreContext()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ipc__bt__enums.html#ga724742f7180d17eda115a13c226d7a0e">cy_en_btipcdrv_status_t</a> Cy_BTIPC_RestoreContext </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__context__t.html">cy_stc_ipc_bt_context_t</a> *&#160;</td>
          <td class="paramname"><em>btIpcContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__ipc__bt__save__ctxt__t.html">cy_stc_ipc_bt_save_ctxt_t</a> *&#160;</td>
          <td class="paramname"><em>pContextRet</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to restore the saved context during RAM off state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pContextRet</td><td>Pointer to the saved context structure to be restored</td></tr>
    <tr><td class="paramname">btIpcContext</td><td>This is the pointer to the bt ipc context structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_BT_IPC_DRV_SUCCESS: BT IPC API return for no error CY_BT_IPC_DRV_ERROR_BAD_HANDLE: BT IPC API return for bad handle </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
